Skip to content
This repository was archived by the owner on Oct 2, 2025. It is now read-only.

add api v1 sunsetting warning #13

Merged
narthur merged 2 commits into from
Sep 5, 2025
Merged

add api v1 sunsetting warning #13

narthur merged 2 commits into from
Sep 5, 2025

Conversation

@narthur
Copy link
Collaborator

@narthur narthur commented Sep 4, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation
    • Changed the API v1 top banner from informational to a warning, stating v1 will be sunset on 2025-09-12 and directing users to v2.
    • Clarifies deprecation timeline and migration path to reduce confusion about v1 stability and future development.
    • No functional changes to APIs or SDKs; document content outside the banner remains unchanged.

Copilot AI review requested due to automatic review settings September 4, 2025 19:21
@coderabbitai
Copy link

coderabbitai bot commented Sep 4, 2025 •
edited
Loading

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

The API v1 documentation’s top banner changed from an informational notice to a warning indicating v1 will be sunset, directing users to v2. No other content or public interfaces were modified.

Changes

Cohort / File(s) Summary
Docs banner update
src/api-v1.md		 Changed top admonition from info to warning, updating text to state v1 deprecation and to direct users to v2.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I twitch my whiskers, read the sign—oh my!
V1’s dusk arrives; V2’s the brighter sky.
I hop along the safer trail ahead,
A warning posted where the info bled.
Carrots packed, I bound with cheer—
New docs, new dawn, less fear!
(_/) ✨

📜 Recent review details

Configuration used: Repository: TaskRatchet/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 2a53d30 and 6f868e9.

📒 Files selected for processing (1)
  • src/api-v1.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/api-v1.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: check-links
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch api-messages

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions
Copy link

github-actions bot commented Sep 4, 2025 •
edited
Loading

User-Visible Improvements

This PR contains 1 user-visible improvement:

  1. Updated the API v1 documentation to inform users that this version of the API will be sunsetted on 2025-09-12 and they should use version 2 instead. (This change informs users about the upcoming deprecation of the API v1, encouraging them to transition to the API v2. This can prevent potential disruptions in their usage of the service.)

Last updated: 2025-09-05T16:00:12.912Z

Copilot AI reviewed Sep 4, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a sunsetting warning to the API v1 documentation, indicating that the version will be deprecated soon and directing users to migrate to version 2.

  • Updates the API v1 documentation to replace the stability notice with a deprecation warning
  • Changes the message type from "info" to "Warning" to indicate urgency
  • Redirects users to use API version 2 instead

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

coderabbitai[bot]
coderabbitai bot reviewed Sep 4, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

📜 Review details

Configuration used: Repository: TaskRatchet/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 32ad9ee and 2a53d30.

📒 Files selected for processing (1)
  • src/api-v1.md (1 hunks)
🧰 Additional context used
🪛 GitHub Check: Linkspector
src/api-v1.md

[failure] 4-4: [linkspector] src/api-v1.md#L4
Cannot reach /api-v2. Status: 404 Cannot find: /api-v2

@narthur narthur temporarily deployed to api-messages - docs.tr.com PR #13 September 5, 2025 15:59 — with Render Destroyed
@narthur narthur merged commit ff31870 into master Sep 5, 2025
4 of 5 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

Copilot code review Copilot Copilot left review comments

+1 more reviewer

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@narthur